Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin.models.utils/SchemaField

SchemaField

@Serializable

class SchemaField(val name: String? = null, val type: SchemaField.SchemaFieldType? = null, val required: Boolean? = null, val system: Boolean? = null, val hidden: Boolean? = null, val presentable: Boolean? = null, val id: String? = null, val min: JsonPrimitive? = null, val max: JsonPrimitive? = null, val exceptDomains: List<String>? = null, val onlyDomains: List<String>? = null, val maxSelect: Int? = null, val maxSize: Long? = null, val autogeneratePattern: String? = null, val pattern: String? = null, val primaryKey: Boolean? = null, val convertUrls: Boolean? = null, val onlyInt: Boolean? = null, val values: List<String>? = null, val mimeTypes: List<String>? = null, val thumbs: List<String>? = null, val protected: Boolean? = null, val collectionId: String? = null, val minSelect: Int? = null, val cascadeDelete: Boolean? = null, val onCreate: Boolean? = null, val onUpdate: Boolean? = null)

The schema for a Collection's field.

There are additional fields that depend on the SchemaFieldType. For a list of them see this file's source

Parameters

name

the name given to the schema by the creator

type

the SchemaFieldType assigned to the schema on creation

required

weather or not, the schema is required to have a value. If this is false, the Serializable class should have an optional(?) type

system

whether the schema is part of the pocketbase system

hidden

whether the field is hidden from JSON API and filters

presentable

whether the field should be prioritized in superuser relations

the unique ID of the schema

Constructors

SchemaField

constructor(name: String? = null, type: SchemaField.SchemaFieldType? = null, required: Boolean? = null, system: Boolean? = null, hidden: Boolean? = null, presentable: Boolean? = null, id: String? = null, min: JsonPrimitive? = null, max: JsonPrimitive? = null, exceptDomains: List<String>? = null, onlyDomains: List<String>? = null, maxSelect: Int? = null, maxSize: Long? = null, autogeneratePattern: String? = null, pattern: String? = null, primaryKey: Boolean? = null, convertUrls: Boolean? = null, onlyInt: Boolean? = null, values: List<String>? = null, mimeTypes: List<String>? = null, thumbs: List<String>? = null, protected: Boolean? = null, collectionId: String? = null, minSelect: Int? = null, cascadeDelete: Boolean? = null, onCreate: Boolean? = null, onUpdate: Boolean? = null)